メルペイ随時決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

MerpayPrePaymentCheck 支払い可否事前確認

指定したサブスクリプションIDの指定した金額での支払い可否を確認することが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
SubscriptionId	subscriptionId	必須半角英数50桁サブスクリプションID 対象のサブスクリプションＩＤを設定します。
Amount	amount	必須半角数字7桁利用金額支払い確認金額を設定します。
Tax	tax	半角数字7桁税送料支払い確認金額を設定します。

URL

/payment/MerpayPrePaymentCheck.json

リクエストパラメータ

{
    "shopID":"tshop11223344",
    "shopPass":"PASSWORD",
    "SubscriptionId":"52c09ac5-4188-4197-b6b0-96bac5f992ff",
    "amount":"500"
}

URL

/payment/MerpayPrePaymentCheck.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&SubscriptionId=52c09ac5-4188-4197-b6b0-96bac5f992ff&Amount=500

レスポンス

正常

SubscriptionId		subscriptionId		必須半角英数50桁サブスクリプションID 対象のサブスクリプションIDを返却します。
CheckResult		checkResult		必須半角英字7桁確認結果支払い可能の場合のみ返却します。・SUCCESS：支払い可能

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
"subscriptionId":"52c09ac5-4188-4197-b6b0-96bac5f992ff",
"checkResult":"SUCCESS"
}

レスポンスパラメータ：正常系

SubscriptionId=52c09ac5-4188-4197-b6b0-96bac5f992ff&CheckResult=SUCCESS

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

EntryTranMerpay 取引登録

これ以降の随時決済で必要となる取引IDと取引パスワードの発行を行い、随時決済を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字8桁処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
Tax	tax	半角数字7桁税送料税送料を指定した場合は、利用金額 + 税送料が決済金額となります。

URL

/payment/EntryTranMerpay.json

リクエストパラメータ

{
    "shopID":"tshop11223344",
    "shopPass":"PASSWORD",
    "orderID":"ORDER0000001",
    "jobCd":"AUTH",
    "amount":"1000"
}

URL

/payment/EntryTranMerpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranMerpay 決済実行

決済処理を行い結果を返却します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass		必須半角英数32桁固定取引パスワード【取引登録】で指定された値を設定します。
OrderID		必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ItemName		商品名（※1）利用可能な文字はこちら
ItemDescription		商品説明（※1）利用可能な文字はこちら
ItemImageUrl1		半角英数記号256桁商品画像URL1（※1）
ItemImageUrl2		半角英数記号256桁商品画像URL2（※1）
ItemImageUrl3		半角英数記号256桁商品画像URL3（※1）
ItemImageUrl4		半角英数記号256桁商品画像URL4（※1）
ItemImageUrl5		半角英数記号256桁商品画像URL5（※1）
ItemImageUrl6		半角英数記号256桁商品画像URL6（※1）
ItemImageUrl7		半角英数記号256桁商品画像URL7（※1）
ItemImageUrl8		半角英数記号256桁商品画像URL8（※1）
ItemImageUrl9		半角英数記号256桁商品画像URL9（※1）
ItemCategory		全半角40桁カテゴリ名（※1）利用可能な文字はこちら
ItemSize		全半角40桁サイズ（※1）利用可能な文字はこちら
ItemBrand		全半角40桁ブランド名（※1）利用可能な文字はこちら
ItemColor		全半角40桁色（※1）利用可能な文字はこちら
ItemListPrice		半角数字7桁定価（※1）
ItemUnitPrice		半角数字7桁購入時価格（※1）
ItemQuantity		半角数字4桁購入数（※1）
ItemItemCode		全半角40桁製品管理コード（SKU）（※1）利用可能な文字はこちら
ItemJanCode		全半角13桁 JANコード（※1）利用可能な文字はこちら
ItemCategoryId		必須半角数字4桁商品カテゴリID（※1）
MultiItem		商品情報一覧複数商品の取り扱いがある場合、指定します。商品情報一覧XMLフォーマットを整形（タブや改行の除去）し、UTF-8でBase64エンコードした値を設定してください。本項目はメルペイかんたん出品連携機能で利用されます。メルペイかんたん出品連携機能をご利用する場合はかんたん出品連携機能についてをご確認ください。メルペイ側で必須になる項目があります。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
SubscriptionType		必須半角英字10桁サブスクリプションタイプ下記を設定します。 SETTLEMENT：随時決済をする
SettlementSubscriptionId		必須半角英数50桁決済用サブスクリプションID 「利用承諾のみ」「都度決済+利用承諾」で発行されたサブスクリプションＩＤを設定してください。

※1：単一商品のみ取り扱いの場合、指定します。
商品情報一覧を指定した場合、本パラメータは無視されます。
本項目はメルペイかんたん出品連携機能で利用されます。
メルペイかんたん出品連携機能をご利用する場合はかんたん出品連携機能についてをご確認ください。
メルペイ側で必須になる項目があります。

URL

/payment/ExecTranMerpay.idPass

リクエストパラメータ（単一商品指定）

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ItemCategoryId=1010&SubscriptionType=SETTLEMENT&SettlementSubscriptionId=87bc26b6-ecce-4340-a531-5bfd691de8eb

リクエストパラメータ（複数商品指定）

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&MultiItem=PGl0ZW1zSW5mbz48aXRlbT48Y2F0ZWdvcnlJZD4xMDEwPC9jYXRlZ29yeUlkPjwvaXRlbT48aXRlbT48Y2F0ZWdvcnlJZD4xMDExPC9jYXRlZ29yeUlkPjwvaXRlbT48L2l0ZW1zSW5mbz4=&SubscriptionType=SETTLEMENT&SettlementSubscriptionId=87bc26b6-ecce-4340-a531-5bfd691de8eb

[商品情報一覧XMLフォーマット]

itemsInfo	商品情報親属性
items	商品情報最大20件まで指定できます。
name	商品名
description	商品説明
imageUrl1	半角英数記号256桁商品画像URL1
imageUrl2	半角英数記号256桁商品画像URL2
imageUrl3	半角英数記号256桁商品画像URL3
imageUrl4	半角英数記号256桁商品画像URL4
imageUrl5	半角英数記号256桁商品画像URL5
imageUrl6	半角英数記号256桁商品画像URL6
imageUrl7	半角英数記号256桁商品画像URL7
imageUrl8	半角英数記号256桁商品画像URL8
imageUrl9	半角英数記号256桁商品画像URL9
category	全半角40桁カテゴリ名
size	全半角40桁サイズ
brand	全半角40桁ブランド名
color	全半角40桁色
listPrice	半角数字7桁定価
unitPrice	半角数字7桁購入時価格
quantity	半角数字4桁購入数
itemCode	全半角40桁製品管理コード（SKU）
janCode	全半角13桁 JANコード
categoryId	必須半角数字4桁商品カテゴリID

XMLヘッダは不要です。
[XMLサンプル]

idPass（複数商品指定）


<itemsInfo>
    <item>
        <name>Tシャツ</name>
        <description>テスト出品です</description>
        <imageUrl1>https://example.com/images/item1.jpg</imageUrl1>
        <category>メンズ</category>
        <size>M</size>
        <brand>テストブランド</brand>
        <color>Black</color>
        <listPrice>1200</listPrice>
        <unitPrice>1000</unitPrice>
        <quantity>1</quantity>
        <itemCode>32882558-1c19-4329-afa3-6a5a8fce8e92</itemCode>
        <janCode>1234567890123</janCode>
        <categoryId>1010</categoryId>
    </item>
    <item>
        <categoryId>1011</categoryId>
    </item>
</itemsInfo>

リクエスト

shopID		必須半角英数13桁ショップID
shopPass		必須半角英数64桁ショップパスワード
accessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
accessPass		必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
orderID		必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
items		必須商品情報一覧最大20件まで指定できます。メルペイかんたん出品連携機能のご利用を検討している場合はかんたん出品連携機能についてをご確認ください。メルペイ側で必須になる項目があります。
	name	商品名利用可能な文字はこちら
	description	商品説明利用可能な文字はこちら
	imageUrls	商品画像URL一覧最大9件、1件あたり256桁まで指定できます。
	category	全半角40桁カテゴリ名利用可能な文字はこちら
	size	全半角40桁サイズ利用可能な文字はこちら
	brand	全半角40桁ブランド名利用可能な文字はこちら
	color	全半角40桁色利用可能な文字はこちら
	listPrice	半角数字7桁定価
	unitPrice	半角数字7桁購入時価格
	quantity	半角数字4桁購入数
	itemCode	全半角40桁製品管理コード利用可能な文字はこちら
	janCode	全半角13桁 JANコード利用可能な文字はこちら
	categoryId	必須半角数字4桁商品カテゴリID
clientField1		全半角100バイト加盟店自由項目1
clientField2		全半角100バイト加盟店自由項目2
clientField3		全半角100バイト加盟店自由項目3
subscriptionType		必須半角英字10桁サブスクリプションタイプ下記を設定します。 SETTLEMENT：随時決済をする
settlementSubscriptionId		必須半角英数50桁決済用サブスクリプションID 「利用承諾のみ」「都度決済+利用承諾」で発行されたサブスクリプションＩＤを設定してください。

URL

/payment/ExecTranMerpay.json

リクエストパラメータ

{
    "shopID":"tshop11223344",
    "shopPass":"PASSWORD",
    "accessID":"a6a6b0061347e90cdef806b39bd28705",
    "accessPass":"5e0e54b892e14ed03e8cf807a6053813",
    "orderID":"ORDER0000001",
    "items":[
        {
            "name":"Tシャツ",
            "description":"テスト出品です",
            "imageUrls":[
                "https://example.com/images/item1.jpg",
                "https://example.com/images/item2.jpg",
                "https://example.com/images/item3.jpg"
            ],
            "category":"メンズ",
            "size":"M",
            "brand":"テストブランド",
            "color":"Black",
            "listPrice":"1200",
            "unitPrice":"1000",
            "quantity":"1",
            "itemCode":"32882558-1c19-4329-afa3-6a5a8fce8e92",
            "janCode":"1234567890123",
            "categoryId":"1010"
        },
        {
            "categoryId":"1011"
        }
    ],
    "subscriptionType":"SETTLEMENT",
    "settlementSubscriptionId":"87bc26b6-ecce-4340-a531-5bfd691de8eb"
}

レスポンス

正常

ShopID	shopID	必須半角英数13桁ショップID
OrderID	orderID	必須半角英数記号27桁固定オーダーID 該当取引のオーダーIDを返却します。
Status	status	必須現状態 AUTH：仮売上 CAPTURE：即時売上 PAYFAIL：決済失敗
TranDate	tranDate	必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
CheckString	checkString	必須半角英数64桁改ざん文字チェック以下の情報を連結し、SHA256ハッシュした値を返却します。・ショップID ・オーダーID ・現状態・処理日時・ショップパスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "shopID":"tshop11223344",
    "orderID":"ORDER0000001",
    "status":"AUTH",
    "tranDate":"20191216090000",
    "checkString":"1e8b27418fcdc9c0214a035cd81c1749"
}

レスポンスパラメータ：正常系

ShopID=tshop11223344&OrderID=ORDER0000001&Status=AUTH&TranDate=20191216090000&CheckString=1e8b27418fcdc9c0214a035cd81c1749

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpaySales 実売上

仮売上の決済に対して実売上を行います。
仮売上の決済の取引ID・取引パスワードを指定すると、売上の確定処理(以下、実売上)が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額税送料を指定した場合は、合計利用金額が売上確定となります。仮売上時の合計利用金額を超える金額は指定できません。仮売上時の合計利用金額に満たない金額を指定した場合、差額はキャンセルされます。（一部実売上の例）　仮売上時の利用金額 = 1000円　指定する利用金額＝ 800円上記の条件で実売上を行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax	tax	半角数字7桁税送料

URL

/payment/MerpaySales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/MerpaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID		orderID		必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status		status		必須現状態 SALES：実売上

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

MerpayCancelReturn キャンセル

仮売上及び実売上取引の取引ID・取引パスワードを指定すると、以前に実施した決済内容をキャンセルすることが可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
Amount	amount	必須半角数字7桁利用金額仮売上および実売上時の合計利用金額と一致する金額を設定するとキャンセルします。（一部キャンセルを行いたい場合）キャンセルしたい金額を設定します。設定した金額がお客様に返金され、差額は実売上の状態のままとなります。例）　実売上時の利用金額 = 1000円　設定した利用金額＝ 200円上記の条件でキャンセルを行った結果　売上金額 = 800円　キャンセル金額 = 200円
Tax	tax	半角数字7桁税送料

URL

/payment/MerpayCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "500"
}

URL

/payment/MerpayCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=500

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態　CANCEL：キャンセル　RETURN：返金　SALES：実売上（※）　CAPTURE：即時売上（※） ※一部キャンセルの場合に返却されます。
InquiryCode	inquiryCode	必須半角英数20桁メルペイ取引番号

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
"orderID":"ORDER0000001",
"status":"RETURN",
"inquiryCode":"012345678901"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=RETURN&InquiryCode=0123456789

レスポンスパラメータ：異常系

[
    {
    "errCode":"E01",
    "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
PayType		必須半角数字2桁決済方法 43：メルペイ

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=43

レスポンス

正常

Status		必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返金 PAYFAIL：決済失敗 EXPIRED：期限切れ
ProcessDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
JobCd		必須処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返金 EXPIRE：期限切れ END：利用終了
AccessID		必須半角英数32桁固定取引ID
AccessPass		必須半角英数32桁固定取引パスワード
Amount		必須半角数字7桁利用金額決済した金額を返却します。
Tax		必須半角数字7桁税送料
ClientField1		必須全半角100バイト加盟店自由項目1
ClientField2		必須全半角100バイト加盟店自由項目2
ClientField3		必須全半角100バイト加盟店自由項目3
PayType		必須半角数字2桁決済方法 43：メルペイ
MerpayCancelAmount		必須半角数字7桁キャンセル金額該当取引について発生したキャンセル・返金額を返却します。
MerpayCancelTax		必須半角数字7桁キャンセル税送料金額該当取引について発生したキャンセル・返金税送料を返却します。
MerpayInquiryCode		半角英数20桁メルペイ取引番号お客様がメルカリアプリで残高履歴等から確認できる取引番号です。現状態がAUTH/SALES/CAPTURE/CANCEL/RETURNのいずれかの場合返却します。
MerpaySubscriptionType		必須サブスクリプションタイプ SETTLEMENT：随時決済をする
MerpaySubscriptionId		半角英数50桁サブスクリプションＩＤ nullで返却します。
MerpaySubscriptionCurrentStatus		サブスクリプション現状態 nullで返却します。
MerpaySubscriptionStartDate		半角数字14桁サブスクリプション利用承諾日時 nullで返却します。
MerpaySubscriptionEndDate		半角数字14桁サブスクリプション利用終了日時 nullで返却します。
MerpaySettlementSubscriptionId		半角英数50桁決済用サブスクリプションID 決済実行時に指定された決済用サブスクリプションＩＤを返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=AUTH&ProcessDate=20191216090000&JobCd=AUTH&AccessID=67ed6da3551771c9f592cd6f7a19a90c&AccessPass=0695cc5eb676f9e11ab6e432f3747941&Amount=10000&Tax=1000&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=43&MerpayCancelAmount=500&MerpayCancelTax=50&MerpayInquiryCode=123456789012&MerpaySubscriptionType=SETTLEMENT&MerpaySubscriptionId=&MerpaySubscriptionCurrentStatus=&MerpaySubscriptionStartDate=&MerpaySubscriptionEndDate=&MerpaySettlementSubscriptionId=52c09ac5-4188-4197-b6b0-96bac5f992ff

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

メルペイ